IRIX Base Documentation 1998 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / SgIconGadget.z / SgIconGadget

Wrap

Text File | 1998-10-30 | 21KB | 331 lines

SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) NNNNAAAAMMMMEEEE SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt ---- tttthhhheeee IIIIccccoooonnnn wwwwiiiiddddggggeeeetttt ccccllllaaaassssssss.... SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////IIIIccccoooonnnnGGGG....hhhh>>>> VVVVEEEERRRRSSSSIIIIOOOONNNN This page documents the version of Sgm that accompanies Motif 2.1. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN SgIconGadget is an instantiable gadget that displays a labeled pixmap. The SgIconGadget widget does not accept any button or key input, and the help callback is the only callback defined. SgIconGadget also receives enter and leave events. The SgIconGadget is unique in that it can be displayed in colors other than that provided by its parent, a restriction that limits the usefulness of gadgets in many situation. SgIconGadget can contain both text and a pixmap. SgIconGadget text is a compound string. Refer to the _O_S_F/ _M_o_t_i_f _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e for more information on compound strings. The text can be multidirectional, multiline, and/or multifont. When a SgIconGadget is insensitive, its text is stippled, or the user-supplied insensitive pixmap is displayed. CCCCllllaaaasssssssseeeessss SgIconGadget inherits behavior and resources from XXXXmmmmGGGGaaaaddddggggeeeetttt. The class pointer is SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeettttCCCCllllaaaassssssss. The class name is SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt. NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss The following table defines a set of widget resources used by the programmer to specify data. The programmer can also set the resource values for the inherited classes to set attributes for this widget. To reference a resource by name or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC prefix and use the remaining letters. To specify one of the defined values for a resource in a .Xdefaults file, remove the XXXXmmmm prefix and use the remaining letters (in either lowercase or uppercase, but include any underscores between words). The codes in the access column indicate if the given resource can be set at creation time (CCCC), set by using XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (SSSS), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (GGGG), or is not applicable (NNNN////AAAA). Page 1 (printed 10/24/98) SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss ________________________________________________________________________________________________________________ XmNfontList XmCFontList XmFontList NULL CSG XmNlabelInsensitivePixmap XmCSgIconGadgetInsensitivePixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNlabelPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNlabelString XmCXmString XmString NULL CSG XmNmarginBottom XmCMarginBottom Dimension 0 CSG XmNmarginHeight XmCMarginHeight Dimension 2 CSG XmNmarginLeft XmCMarginLeft Dimension 0 CSG XmNmarginRight XmCMarginRight Dimension 0 CSG XmNmarginTop XmCMarginTop Dimension 0 CSG XmNmarginWidth XmCMarginWidth Dimension 2 CSG XmNspacing XmCSpacing Dimension 10 CSG XmNrecomputeSize XmCRecomputeSize Boolean True CSG XmNstringDirection XmCStringDirection XmStringDirection XmNtopShadowColor XmCTopShadow Pixel dynamic CSG XmNbottomShadowColor XmCBottomShadow Pixel dynamic CSG XmNbackground XmCBackground Pixel dynamic CSG XmNforeground XmCForeground Pixel dynamic CSG XmNiconPlacement XmCIconPlacement XmRIconPlacement icon_right csg XmNpixmapWidth XmCWidth Dimension 16 CSG XmNpixmapHeight XmCHeight Dimension 16 CSG XmNshadowType XmCShadowType XmRShadowType XmSHADOW_ETCHED_IN csg XXXXmmmmNNNNffffoooonnnnttttLLLLiiiisssstttt Specifies the font of the text used in the widget. If this value is NULL at initialization, it is initialized by looking up the parent hierarchy of the widget for an ancestor that is a subclass of the XmBulletinBoard, VendorShell, or XmMenuShell widget class. If such an ancestor is found, the font list is initialized to the appropriate default font list of the ancestor widget (XmNdefaultFontList for VendorShell and XmMenuShell, XmNlabelFontList or XmNbuttonFontList for XmBulletinBoard). Refer to XXXXmmmmFFFFoooonnnnttttLLLLiiiissssttttCCCCrrrreeeeaaaatttteeee((((3333XXXX)))) for more information on the creation and structure of a font list. XXXXmmmmNNNNllllaaaabbbbeeeellllIIIInnnnsssseeeennnnssssiiiittttiiiivvvveeeePPPPiiiixxxxmmmmaaaapppp Specifies a pixmap used as the button face if XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP and the button is insensitive. XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp Specifies the optional pixmap displayed. XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP. XXXXmmmmNNNNllllaaaabbbbeeeellllSSSSttttrrrriiiinnnngggg Specifies the compound string displayed. Refer to XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCrrrreeeeaaaatttteeee((((3333XXXX)))) or XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCrrrreeeeaaaatttteeeeLLLLttttooooRRRR((((3333XXXX)))) for more information on the creation and structure of compound strings. Page 2 (printed 10/24/98) SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnBBBBoooottttttttoooommmm Specifies the amount of spacing that is to be left after the bottom margin (XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt) of the widget, before the label is drawn. XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt Specifies the amount of blank space between the bottom edge of the top shadow and the label, and the top edge of the bottom shadow and the label. XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnLLLLeeeefffftttt Specifies the amount of spacing that is to be left after the left margin (XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh) of the widget before the label is drawn. This may be modified by SgIconGadget's subclasses. XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnRRRRiiiigggghhhhtttt Specifies the amount of spacing that is to be left after the right margin (XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh) of the widget before the label is drawn. XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnTTTToooopppp Specifies the amount of spacing that is to be left after the top margin (XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt) of the widget before the label is drawn. XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh Specifies the amount of blank space between the right edge of the left shadow and the label, and the left edge of the right shadow and the label. XXXXmmmmNNNNssssppppaaaacccciiiinnnngggg Specifies the amount of blank space between the label and the pixmap. XXXXmmmmNNNNrrrreeeeccccoooommmmppppuuuutttteeeeSSSSiiiizzzzeeee Specifies a Boolean value that indicates whether the widget attempts to be big enough to contain the label. If True, an XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss with a new label string or pixmap, margins, font, or label type causes the widget to shrink or expand to exactly fit the new label string or pixmap. If False, the widget never attempts to change size on its own. XXXXmmmmNNNNssssttttrrrriiiinnnnggggDDDDiiiirrrreeeeccccttttiiiioooonnnn Specifies the direction in which the string is to be drawn. The following are the values: +o XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG____DDDDIIIIRRRREEEECCCCTTTTIIIIOOOONNNN____LLLL____TTTTOOOO____RRRR - left to right +o XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG____DDDDIIIIRRRREEEECCCCTTTTIIIIOOOONNNN____RRRR____TTTTOOOO____LLLL - right to left Page 3 (printed 10/24/98) SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) The value of this resource is determined at creation time. If the widget's parent is a manager, this value is inherited from the widget's parent, otherwise it is set to XmSTRING_DIRECTION_L_TO_R. IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss SgIconGadget inherits behavior and resources from the following superclasses. For a complete description of each resource, refer to the man page for that superclass. XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss ____________________________________________________________________________________ XmNhelpCallback XmCCallback XtCallbackList NULL C XmNhighlightColor XmCForeground Pixel Black CSG XmNhighlightOnEnter XmCHighlightOnEnter Boolean False CSG XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG XmNhighlightThickness XmCHighlightThickness Dimension 2 CSG XmNnavigationType XmCNavigationType XmNavigationType XmNONE G XmNtraversalOn XmCTraversalOn Boolean False CSG XmNunitType XmCUnitType unsigned char XmPIXELS CSG XmNuserData XmCUserData caddr_t NULL CSG CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss __________________________________________________________________________________________________________ XmNancestorSensitive XmCSensitive Boolean dynamic G XmNcolormap XmCColormap Colormap XtCopyFromParent CG XmNdepth XmCDepth int XtCopyFromParent CG XmNdestroyCallback XmCCallback XtCallbackList NULL C XmNheight XmCHeight Dimension dynamic CSG XmNinitialResourcesPersistent XmCInitialResourcesPersistent Boolean True CG XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG XmNscreen XmCScreen Pointer XtCopyScreen CG XmNsensitive XmCSensitive Boolean True CSG XmNtranslations XmCTranslations XtTranslations NULL CSG XmNwidth XmCWidth Dimension dynamic CSG XmNx XmCPosition Position 0 CSG XmNy XmCPosition Position 0 CSG CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn The following structure is returned with each callback: ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt { iiiinnnntttt _r_e_a_s_o_n; XXXXEEEEvvvveeeennnntttt * _e_v_e_n_t;;;; }}}} XXXXmmmmAAAAnnnnyyyyCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;; Page 4 (printed 10/24/98) SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV SSSSggggIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))) _r_e_a_s_o_n Indicates why the callback was invoked. For this callback, _r_e_a_s_o_n is set to XXXXmmmmCCCCRRRR____HHHHEEEELLLLPPPP. _e_v_e_n_t Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback. TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss SgIconGadget includes translations from Primitive. The SgIconGadget translations are listed below. These translations may not directly correspond to a translation table. KKKKHHHHeeeellllpppp:::: HHHHeeeellllpppp(((()))) AAAAccccttttiiiioooonnnn RRRRoooouuuuttttiiiinnnneeeessss The SgIconGadget action routines are described below: HHHHeeeellllpppp(((()))): Calls the callbacks for XXXXmmmmNNNNHHHHeeeellllppppCCCCaaaallllllllbbbbaaaacccckkkk if any exist. If there are no help callbacks for this widget, this action calls the help callbacks for the nearest ancestor that has them. RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN CCCCoooorrrreeee((((3333XXXX)))), SSSSggggCCCCrrrreeeeaaaatttteeeeIIIIccccoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))), XXXXmmmmFFFFoooonnnnttttLLLLiiiissssttttCCCCrrrreeeeaaaatttteeee((((3333XXXX)))), XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCrrrreeeeaaaatttteeee((((3333XXXX)))), XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCrrrreeeeaaaatttteeeeLLLLttttooooRRRR((((3333XXXX)))) and XXXXmmmmGGGGaaaaddddggggeeeetttt((((3333XXXX)))). Page 5 (printed 10/24/98)